@types/socket.io

What is @types/socket.io?

@types/socket.io provides TypeScript type definitions for the Socket.IO library, which is used for real-time, bidirectional communication between web clients and servers.

What are @types/socket.io's main functionalities?

Server-Side Socket Handling

This feature allows you to set up a Socket.IO server that listens for client connections and disconnections.

const io = require('socket.io')(3000);
io.on('connection', (socket) => {
  console.log('a user connected');
  socket.on('disconnect', () => {
    console.log('user disconnected');
  });
});

Client-Side Socket Handling

This feature allows you to set up a Socket.IO client that connects to a server and listens for connection and disconnection events.

const socket = io('http://localhost:3000');
socket.on('connect', () => {
  console.log('connected to server');
});
socket.on('disconnect', () => {
  console.log('disconnected from server');
});

Emitting and Listening to Events

This feature allows you to emit and listen to custom events between the server and client.

const io = require('socket.io')(3000);
io.on('connection', (socket) => {
  socket.on('chat message', (msg) => {
    io.emit('chat message', msg);
  });
});

const socket = io('http://localhost:3000');
socket.emit('chat message', 'Hello World');
socket.on('chat message', (msg) => {
  console.log('message: ' + msg);
});

Other packages similar to @types/socket.io

@types/ws

@types/ws provides TypeScript type definitions for the ws library, which is a simple to use, blazing fast, and thoroughly tested WebSocket client and server for Node.js. It is more lightweight compared to Socket.IO but does not support fallback options like long-polling.

@types/primus

@types/primus provides TypeScript type definitions for the Primus library, which is a flexible and extensible framework for real-time applications. Primus supports multiple real-time frameworks and can switch between them without changing the application code.

@types/sockjs

@types/sockjs provides TypeScript type definitions for the SockJS library, which is a JavaScript library that provides a WebSocket-like object for browsers. SockJS is designed to work with existing WebSocket servers and provides a fallback for browsers that do not support WebSockets.

README

Installation

npm install --save @types/socket.io

Summary

This package contains type definitions for socket.io (http://socket.io/).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/socket.io.

Additional Details

• Last updated: Mon, 25 Jan 2021 21:56:06 GMT
• Dependencies: @types/engine.io, @types/socket.io-parser, @types/node
• Global values: SocketIO

Credits

These definitions were written by PROGRE, Damian Connolly, Florent Poujol, KentarouTakeda, Alexey Snigirev, Ezinwa Okpoechi, Marek Urbanowicz, and Kevin Kam.